Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Generate SBOM #245

Merged
merged 2 commits into from
Mar 14, 2024
Merged

ci: Generate SBOM #245

merged 2 commits into from
Mar 14, 2024

Conversation

jenshenneberg
Copy link
Contributor

@jenshenneberg jenshenneberg commented Mar 10, 2024

This PR

Generates Software Bill of Materials (SBOM) as described in #159. Once NuGet/Home#12497 is implemented, the SBOM file(s) should be embedded in the published nuget packages. Until then, I've added the SBOM as an asset under the release.

Known issue

The SBOM file lists the dependences for all target frameworks combined. Once the above NuGet issue is implemented, it should be changed, so there is one sbom created for each target framework with only the applicable references included.

Related Issues

Fixes #159

How to test

Unfortunately, this is somewhat cumbersome to test, as the logic in question only kicks in upon a release from the main branch. I've tested it myself this way:

  • Create new fork of this repo
  • Merge this branch to main in the new repo
  • Create a release in the new repo

@jenshenneberg jenshenneberg changed the title Generate SBOM for release fix: Generate SBOM for release Mar 10, 2024
@jenshenneberg jenshenneberg marked this pull request as ready for review March 10, 2024 20:15
@jenshenneberg jenshenneberg requested a review from a team as a code owner March 10, 2024 20:15
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.47%. Comparing base (b23334b) to head (5403659).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #245   +/-   ##
=======================================
  Coverage   94.47%   94.47%           
=======================================
  Files          27       27           
  Lines        1104     1104           
  Branches      119      119           
=======================================
  Hits         1043     1043           
  Misses         37       37           
  Partials       24       24           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@askpt askpt changed the title fix: Generate SBOM for release fix: Generate SBOM Mar 11, 2024
@askpt askpt changed the title fix: Generate SBOM ci: Generate SBOM Mar 11, 2024
@toddbaert
Copy link
Member

Wow thanks @jenshenneberg ! I will review this carefully tomorrow.

Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but we may want to preview the CI from failing until it has run successfully.

.github/workflows/release.yml Show resolved Hide resolved
Signed-off-by: Jens Henneberg <[email protected]>
@jenshenneberg
Copy link
Contributor Author

jenshenneberg commented Mar 13, 2024

Comment addressed (after some GitHub challenges).

@jenshenneberg jenshenneberg force-pushed the generatesbom branch 2 times, most recently from 42fa07a to 5230768 Compare March 13, 2024 01:53
Copy link
Member

@beeme1mr beeme1mr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you! 🎉

Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya this looks good to me, thanks for also extracting the conditions.

I'll merge tomorrow unless I hear objections from maintainers.

@toddbaert toddbaert merged commit 3bdcf77 into open-feature:main Mar 14, 2024
12 checks passed
arttonoyan pushed a commit to arttonoyan/dotnet-sdk that referenced this pull request Nov 17, 2024
## This PR
Generates Software Bill of Materials (SBOM) as described in open-feature#159. Once
NuGet/Home#12497 is implemented, the SBOM
file(s) should be embedded in the published nuget packages. Until then,
I've added the SBOM as an asset under the release.

### Known issue
The SBOM file lists the dependences for all target frameworks combined.
Once the above [NuGet ](NuGet/Home#12497
is implemented, it should be changed, so there is one sbom created for
each target framework with only the applicable references included.

### Related Issues
Fixes open-feature#159

### How to test
Unfortunately, this is somewhat cumbersome to test, as the logic in
question only kicks in upon a release from the main branch. I've tested
it myself this way:
- Create new fork of this repo
- Merge this branch to main in the new repo
- Create a release in the new repo

Signed-off-by: Jens Henneberg <[email protected]>
Co-authored-by: André Silva <[email protected]>
Signed-off-by: Artyom Tonoyan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate SBOMs for .NET components
5 participants